/*
 * Copyright (C) 2008 Rob Cash
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * StateChangeEvent.java
 * 
 * Created on Jan 1, 2009 at 12:38:37 PM
 */

package org.robcash.commons.event;

import java.util.EventObject;
import org.robcash.commons.util.State;
import org.robcash.commons.util.StateMachine;

/**
 * A state change event is used to contain information about changes to a state
 * machine
 * @author Rob
 */
public class StateChangeEvent extends EventObject {

    /**
     * Old state
     */
    private State oldState;

    /**
     * New state
     */
    private State newState;

    /**
     * Creates a new state change event
     * @param stateMachine State machine that originated the event
     */
    public StateChangeEvent(StateMachine stateMachine) {
        super(stateMachine);
    }

    /**
     * Creates a new state change event
     * @param stateMachine State machine that originated the event
     * @param oldState State from which the state machine is transitioning
     * @param newState State to which the state machine is transitioning
     */
    public StateChangeEvent(StateMachine stateMachine, State oldState, State newState) {
        super(stateMachine);
        this.oldState = oldState;
        this.newState = newState;
    }

    /**
     * Get the new state
     * @return New state
     */
    public State getNewState() {
        return newState;
    }

    /**
     * Get the old state
     * @return Old state
     */
    public State getOldState() {
        return oldState;
    }

}
